/*
 * Copyright (c) 2013, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.graalvm.visualizer.filter;

import org.graalvm.visualizer.graph.Diagram;
import org.graalvm.visualizer.script.ScriptEnvironment;

/**
 * Monitors execution of filters, reports start/end of a filter run
 *
 * @author sdedic
 */
public interface FilterExecutionService {
    /**
     * Prepares execution of the chain, the caller will be able to cancel the
     * process from another thread. This call will prepare the execution object,
     * which allows to run the actual processing and serves as a handle to cancel
     * the processing.
     *
     * @param d        The diagram to process
     * @param sequence the filter source
     * @return processing control object
     */
    public FilterExecution createExecution(FilterChain sequence, ScriptEnvironment env, Diagram d);

    public void addFilterListener(FilterListener l);

    public void removeFilterListener(FilterListener l);
}
